Package com.cisco.pt.ipc.sim
Interface RemoteNetwork
- All Known Implementing Classes:
RemoteNetworkImpl
Information provided by the PKI file:
\class RemoteNetwork
\brief RemoteNetwork handles and manipulates Multiuser remote networks.
\example multiUserManager().getRemoteNetworkAt(0)
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionbooleanInformation provided by the PKI file:voidInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidsetConnectAsUserName(String username) Information provided by the PKI file:voidsetMode(boolean bOutgoing) Information provided by the PKI file:voidsetPassword(String password) Information provided by the PKI file:voidsetPeerAddress(String address) Information provided by the PKI file:voidsetPortNumber(int port) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.sim.Device
activityTreeToXml, addCustomVar, addDeviceExternalAttributes, addModule, addProgrammingSerialOutputs, addSound, addUserDesktopApp, addUserDesktopAppFromGlobal, clearDeviceExternalAttributes, clearProgrammingSerialOutputs, destroySounds, getAreaLeftX, getAreaTopY, getCenterXCoordinate, getCenterYCoordinate, getCommandLine, getCustomInterface, getCustomLogicalImage, getCustomPhysicalImage, getCustomVarNameAt, getCustomVarsCount, getCustomVarStr, getCustomVarValueStrAt, getDescriptor, getDeviceExternalAttributes, getDeviceExternalAttributeValue, getGlobalXPhysicalWS, getGlobalYPhysicalWS, getModel, getName, getPhysicalObject, getPort, getPortAt, getPortCount, getPorts, getPower, getProcess, getProgrammingSerialOutputs, getRootModule, getSerialNumber, getSupportedModule, getType, getUpTime, getUsbPortAt, getUsbPortCount, getUserDesktopAppAt, getUserDesktopAppByDir, getUserDesktopAppById, getUserDesktopAppCount, getXCoordinate, getXPhysicalWS, getYCoordinate, getYPhysicalWS, hasCustomVar, isDesktopAvailable, isOutdated, isProjectRunning, moveByInPhysicalWS, moveToLocation, moveToLocationCentered, moveToLocInPhysicalWS, playSound, relinkUserDesktopApp, removeCustomVar, removeModule, removeUserDesktopApp, restoreToDefault, runCodeInProject, runProject, serializeToXml, setCustomInterface, setCustomLogicalImage, setCustomPhysicalImage, setDeviceExternalAttributes, setName, setPower, setTime, stopProject, stopSound, stopSounds, subtractDeviceExternalAttributes, updateTemplateCreationTimeMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
connect
Information provided by the PKI file:
\brief Makes a Multiuser connection to a peer remote network. \param peerAddress, the peer address of the peer remote network. \param peerPort, the peer port number of the peer remote network. \param userName, the peer network name of the peer remote network. \param password, the peer password of the peer remote network. \return bool, true if successful, otherwise false.- Parameters:
peerAddress- Takes in a parameter of peerAddresspeerPort- Takes in a parameter of peerPortuserName- Takes in a parameter of userNamepassword- Takes in a parameter of password- Returns:
- boolean Returns a boolean
-
disconnect
void disconnect()Information provided by the PKI file:
\brief Disconnects the Multiuser connection. -
isConnected
boolean isConnected()Information provided by the PKI file:
\brief Returns true if the remote network is connected, otherwise false. \return bool, true if the remote network is connected, otherwise false.- Returns:
- boolean Returns a boolean
-
setPeerAddress
Information provided by the PKI file:
\brief Sets the peer address for the outgoing connection. \param address, the peer address for the outgoing connection.- Parameters:
address- Takes in a parameter of address
-
getPeerAddress
String getPeerAddress()Information provided by the PKI file:
\brief Returns the peer address for the outgoing connection. \return QString, the peer address for the outgoing connection.- Returns:
- String Returns a String
-
setPortNumber
void setPortNumber(int port) Information provided by the PKI file:
\brief Sets the peer port number for the outgoing connection. \param port, the peer port number for the outgoing connection.- Parameters:
port- Takes in a parameter of port
-
getPortNumber
int getPortNumber()Information provided by the PKI file:
\brief Returns the peer port number for the outgoing connection. \return int, the peer port number for the outgoing connection.- Returns:
- int Returns a int
-
setConnectAsUserName
Information provided by the PKI file:
\brief Sets the user name entered when making the outgoing connection. \param username, the username to use.- Parameters:
username- Takes in a parameter of username
-
getConnectAsUserName
String getConnectAsUserName()Information provided by the PKI file:
\brief Returns the peer network name for the outgoing connection. \return QString, the peer network name for the outgoing connection.- Returns:
- String Returns a String
-
setPassword
Information provided by the PKI file:
\brief Sets the peer password for the outgoing connection. \param password, the peer password for the outgoing connection.- Parameters:
password- Takes in a parameter of password
-
getPassword
String getPassword()Information provided by the PKI file:
\brief Returns the peer password for the outgoing connection. \return QString, the peer password for the outgoing connection.- Returns:
- String Returns a String
-
setMode
void setMode(boolean bOutgoing) Information provided by the PKI file:
\brief Sets the Multiuser connection type to outgoing or incoming. \param bOutgoing, true for outgoing connection, false for incoming connection.- Parameters:
bOutgoing- Takes in a parameter of bOutgoing
-
isOutgoing
boolean isOutgoing()Information provided by the PKI file:
\brief Returns true if the remote network is set to outgoing connection, false if incoming connection. \return bool, true if the remote network is set to outgoing connection, false if incoming connection.- Returns:
- boolean Returns a boolean
-